Skip to content

docs: rename pip install burr -> pip install apache-burr#772

Merged
elijahbenizzy merged 1 commit into
mainfrom
chore/rename-burr-to-apache-burr-in-docs
May 11, 2026
Merged

docs: rename pip install burr -> pip install apache-burr#772
elijahbenizzy merged 1 commit into
mainfrom
chore/rename-burr-to-apache-burr-in-docs

Conversation

@elijahbenizzy
Copy link
Copy Markdown
Contributor

Summary

The PyPI package was renamed to apache-burr at the 0.41.0-incubating release, but ~30 files in docs, examples, and a few in-code error messages still tell users pip install burr[...]. That doesn't work — PyPI's burr is an unrelated placeholder.

This is a pure mechanical sweep:

  • 32 files touched, 56 single-line replacements
  • Only changes pip install <maybe-quoted>burr[...]pip install <maybe-quoted>apache-burr[...]
  • Does NOT touch import burr, from burr.<...>, the burr CLI command name, or any file paths

Sibling change: apache/hamilton#1561 does the same sf-hamiltonapache-hamilton cleanup.

Test plan

  • CI green (release-validation, tests, lint)
  • Spot-check rendered docs/getting_started/install.rst on the docs site after merge

@github-actions github-actions Bot added area/core Application, State, Graph, Actions area/storage Persisters, state storage area/tracking Telemetry, tracing, OpenTelemetry area/website burr.apache.org website area/examples Relates to /examples labels May 11, 2026
The PyPI package was renamed to apache-burr at the 0.41.0
release, but ~30 files in docs, examples, and a few error
messages still tell users to `pip install burr[...]`. That
doesn't work — PyPI's `burr` is a placeholder.

This is a pure mechanical sweep that only touches `pip install`
invocations. Module imports (`import burr`, `from burr...`),
the `burr` CLI command name, and file paths are untouched.
@elijahbenizzy elijahbenizzy force-pushed the chore/rename-burr-to-apache-burr-in-docs branch from c41b657 to cd3b8c6 Compare May 11, 2026 21:27
@elijahbenizzy elijahbenizzy merged commit 83f2ea8 into main May 11, 2026
28 checks passed
@elijahbenizzy elijahbenizzy deleted the chore/rename-burr-to-apache-burr-in-docs branch May 11, 2026 21:33
skrawcz pushed a commit that referenced this pull request May 16, 2026
…777)

Two follow-up cleanups for the Apache rename:

* 14 example READMEs + 2 notebooks linked `dagworks-inc/burr`
  Colab URLs (or a commented git URL in the s3 Dockerfile) that
  404 since the repo moved to `apache/burr`.

* 11 install lines escaped PR #772's regex (the JSON-escaped
  `\"burr[...]` form in notebook cells, and a `poetry add` form)
  and still said `pip install "burr[extras]"`. PyPI's `burr` is
  an unrelated placeholder, so these instructions don't work.

Pure mechanical sweep. No code or behavior changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/core Application, State, Graph, Actions area/examples Relates to /examples area/storage Persisters, state storage area/tracking Telemetry, tracing, OpenTelemetry area/website burr.apache.org website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants